<?php
 /**
 * Setting Config Files
 * 
 * This topic will tell you what config item does what
 * 
 * @editing     This page is specific to CI Docs documentation, therefor should not be edited
 * @url     /general/setting_config_files
 */
?>

<h1><?php echo $title; ?></h1>

<p>CI Docs will have three main config files. The first is for CodeIgniter. Then of the remaining two, one will be the settings for CI Docs and one will hold settings for specific User Guides.</p>

<ul>
	<li><a href="#CI_Config">Setting CI Config</a></li>
	<li><a href="#CI_Docs_Config">Setting CI Docs Config</a></li>
	<li><a href="#User_Guide_Config">Setting User Guide Config</a></li>
</ul>

<!-- !CI Config -->

<br/>
<h1 id="CI_Config">Setting CI Config</h1>

<p>The CI Config will be setting the base url and language of CI Docs. We need to do this in the CI Config otherwise some things may not come out correctly.</p>

<h2>Base Url</h2>
<p>This is the base url of your CI Docs site with a trailing slash.</p>
<code>$config['base_url']	= "http://domain.com/";</code>

<h2>Index Page</h2>
<p>Set the index page. If you are using <strong>mod_rewrite</strong> you will need to set this to be blank. The default is blank because we start with <strong>mod_rewrite</strong> enabled. If you are not using <strong>mod_rewrite</strong> you need to set this as <dfn>index.php</dfn> or whatever the name is of your main file.</p>
<code>$config['index_page'] = "";</code>

<h2>Url Suffix</h2>
<p>Set the url suffix for topics. This would be something like <dfn>.html</dfn> or <dfn>.php</dfn> to give you a url of <dfn>http://docs.domain.com/table_of_contents.htm</dfn>. The default is to be blank.</p>
<code>$config['url_suffix'] = "";</code>

<h2>Language</h2>
<p>Set the default language of CI Docs that will be used when choosing which language file to load.</p>
<code>$config['language']	= "english";</code>

<!-- !CI Docs Config -->

<br/>
<h1 id="CI_Docs_Config">Setting CI Docs Config</h1>

<p>The CI Docs Config will hold the main config for CI Docs which will act globally across all User Guides. Below is a list of available config items and their values:</p>


<h2>Multi Guide Support</h2>
<p>Enable <?php echo $this->toc->link('general/multi_guide_support', 'multi guide support'); ?> if you want to have multiple documentations on one install. If disabled your guide will be in the root of the website <dfn>http://docs.domain.com/</dfn>. If enabled your guide root url will be <dfn>http://docs.domain.com/<var>USER_GUIDE_NAME</var>/</dfn> and the root of the website will be a table of contents of user guides.</p>
<code>$config['multi_guide_support'] = FALSE;</code>

<h2>Default User Guide</h2>
<p>If not using multi guide support, this will set your default guide. Required if not using multi guide support.</p>
<code>$config['default_user_guide'] = 'CI Docs';</code>

<h2>Lang Prefix ID</h2>
<p>This will be the id for a shortcut to the lang() function when used in functions. For example, in the Toc Library when you inert a <dfn>->category(<var>$name</var>, <var>$url</var>)</dfn> you can use:</p>
<code>->category(':lang_item')   would be the same as   ->category(lang('lang_item'))</code>
<code>$config['lang_prefix_id'] = ':';</code>

<h2>Path to the licenses folder</h2>
<p>Path where you keep your licenses.</p>
<code>$config['licenses_path'] = '_licenses';</code>
<p class="important"><strong>Important:</strong> currently required to be in <dfn>/app/user_guides/</dfn> or deeper</p>

<!-- !User Guide Config -->

<br/>
<h1 id="User_Guide_Config">Setting User Guide Config</h1>

<p>The User Guide Config will hold the settings for a specific User Guide. Majority of your settings will be in this file. Below is a list of available config items and their values:</p>

<h2>Guide Name</h2>
<p>The name of your guide. Appears in main title and other places around the site.</p>
<code>$config['guide_name'] = 'CI Docs';</code>

<h2>Guide Version</h2>
<p>The version of the guide or app it belongs to.</p>
<code>$config['guide_version'] = '0.1b';</code>

<h2>Author Name</h2>
<p>Can be a group, company, individual etc. Will show up in the footer copyright, licensing, etc.</p>
<code>$config['author'] = 'chad with uh c';</code>

<h2>Author's Real Name</h2>
<p>This is used in licensing information. You may use an alias name if you'd like.</p>
<code>$config['author_real_name'] = 'chad drummond';</code>

<h2>Author's URL</h2>
<p>The web address of the author's website.</p>
<code>$config['author_url'] = 'http://chadwithuhc.com/';</code>
<p class="note"><strong>Note:</strong> If you don't have a web address simply put <dfn>/</dfn> to redirect back to the user guide</p>

<h2>Author's Email</h2>
<p>The email address of the author. If you don't want your email shown you can shut it off in the CI Docs config file.</p>
<code>$config['author_email'] = '&lt;me@chadwithuhc.com&gt;';</code>

<h2>Copyright Year</h2>
<p>Set the copyright year for your guide.</p>
<code>$config['copyright_year'] = date('Y', time());</code>

<h2>Page Title Format</h2>
<p>The way to format the page title, for people who want to get personal.</p>
<h3>Options</h3>
<table class="table">
	<thead>
		<tr>
			<th>Setting</th>
			<th>Value</th>
			<th>Example</th>
		</tr>
	</thead>
	<tbody>
		<tr>
			<td><strong>normal</strong></td>
			<td>GUIDE_NAME : CATEGORY : PAGE</td>
			<td>CI Docs User Guide : General Topics : Setting Config Files</td>
		</tr>
		<tr>
			<td><strong>normal</strong></td>
			<td>PAGE : CATEGORY : GUIDE_NAME</td>
			<td>Setting Config Files : General Topics : CI Docs User Guide</td>
		</tr>
		<tr>
			<td><strong>name_only</strong></td>
			<td>GUIDE_NAME</td>
			<td>CI Docs User Guide</td>
		</tr>
	</tbody>
</table>
<code>$config['title_format'] = 'reverse';</code>

<h2>Keywords</h2>
<p>The meta keywords to include with your guide.</p>
<code>$config['keywords'] = 'code igniter, codeigniter, ci, web, application, documentation, user guide, docs';</code>

<h2>Description</h2>
<p>The meta description for your guide to help understand what it's about.</p>
<code>$config['description'] = 'CI Docs helps you quickly document your CI application in a fraction of the time';</code>

<h2>Robots</h2>
<p>The meta robots rules for your guide.</p>
<code>$config['robots'] = 'index, follow';</code>

<h2>Available Licenses</h2>
<p>This is an array of available licenses you can use for the license topic. You may add your own if youd like in <dfn>/app/user_guides/_licenses</dfn>. If adding your own, make sure to add it to the array.</p>
<pre>
$config['available_licenses'] = array(
	'custom' => 'Custom License',
	'GPL' => 'GNU General Public License (GPL)',
	'GPL3' => 'GNU General Public License version 3.0 (GPLv3)',
	'LGPL' => 'GNU Library or "Lesser" General Public License (LGPL)',
	'LGPL3' => 'GNU Library or "Lesser" General Public License version 3.0 (LGPLv3)',
	'MIT' => 'MIT License',
	'BSD' => 'BSD License',
	'APACHE2' => 'Apache License, 2.0',
	'MPL' => 'Mozilla Public License 1.1 (MPL)',
	'NPOSL3' => 'Non-Profit Open Software License 3.0 (Non-Profit OSL 3.0)',
	'OSL3' => 'Open Software License 3.0 (OSL 3.0)'
	);
</pre>
<p class="note"><strong>Note:</strong> A longer list of Open Source Licenses can be found at <a href="http://www.opensource.org/licenses/alphabetical" target="_blank" title="Open Source Licenses">http://www.opensource.org/licenses/alphabetical</a> or create your own at <a href="http://creativecommons.org/license/" target="_blank">http://creativecommons.org/license/</a></p>

<h2>License to use</h2>
<p>The license ID of which license to use. ID's can be found above.</p>
<code>$config['license_id'] = 'MIT';</code>

<h2>Language Files</h2>
<p>Additional language files to load from your user guide directory. Any language keys that get loaded here will overwrite whats in <dfn>ci_docs_lang.php</dfn> of the application language folder.</p>
<code>$config['language_files'] = array();</code>
<p class="note"><strong>Note:</strong> We will automatically try to load the file <dfn><var>GUIDE_NAME</var>_lang.php</dfn> and does not need to be in the array</p>

<h2>Version Support</h2>
<p>Version support will allow you to have a folder for each version so users can view previous versions of your user guides. Read more about Version Support at <?php echo $this->toc->link('general/version_support', 'the Version Support Page'); ?>.</p>
<code>$config['version_support'] = FALSE;</code>

<!--
<h2>Include Category Homepages</h2>
<p>This will include homepages for the categories you put into the table of contents. If you have ->category('Basic Info', 'info') then the category homepage will be info/index</p>
<code>$config['include_category_homepages'] = FALSE;</code>
-->

<h2>Show category name in next and prev topic</h2>
<p>Will include the category name in next and prev topic links.</p>
<code>$config['show_cat_name_in_topic'] = TRUE;</code>

<h2>Show Author Email</h2>
<p>Show your email around the site where necessary.</p>
<code>$config['show_email'] = TRUE;</code>
<p class="note"><strong>Note:</strong> Currently shown in License and Meta Author</p>

<h2>Use Advanced Breadcrum Nav</h2>
<p>This will enable the breadcrumb nav to have the Prev and Next topics in it as well as your location.</p>
<code>$config['use_advanced_breadcrumb'] = TRUE;</code>

<h2>Advanced Breadcrumb Placement</h2>
<p>This lets you choose where to place the advanced breadcrumb part.</p>
<h3>Options</h3>
<table class="table">
	<thead>
		<tr>
			<th>Setting</th>
			<th>Description</th>
		</tr>
	</thead>
	<tbody>
		<tr>
			<td><strong>top</strong></td>
			<td>Shows centered on the same line as the User Guide title</td>
		</tr>
		<tr>
			<td><strong>middle</strong></td>
			<td>Shows centered between the User Guide title and topics content</td>
		</tr>
		<tr>
			<td><strong>left</strong></td>
			<td>Shows on the left under the breadcrumb nav line</td>
		</tr>
	</tbody>
</table>
<code>$config['advanced_breadcrumb_position'] = 'top';</code>